Skip to content

docs(cli): document the new Warp Agent CLI slash commands - #493

Open
hongyi-chen wants to merge 3 commits into
mainfrom
docs/cli-slash-commands
Open

docs(cli): document the new Warp Agent CLI slash commands#493
hongyi-chen wants to merge 3 commits into
mainfrom
docs/cli-slash-commands

Conversation

@hongyi-chen

@hongyi-chen hongyi-chen commented Aug 7, 2026 •
edited by warp-agent-staging Bot
Loading

Copy link
Copy Markdown
Collaborator

Documents the Warp Agent CLI slash commands that the missing_docs drift-watch audit flagged as new-but-undocumented, plus the ones already in the registry that the CLI reference table was missing.

Originating thread: https://warpdev.slack.com/archives/C09BVK0PL3Y/p1786300744335669

What changed

cli/reference.mdx — added the missing rows to the slash command table so it matches app/src/search/slash_command_menu/static_commands/commands.rs:

  • /connect-grok — connect an X Premium or SuperGrok subscription (new, flagged by the audit)
  • /manage-billing — open the team billing page (new, flagged by the audit)
  • /upgrade — open the Warp upgrade page (new, flagged by the audit)
  • /fork, /reset-statusline, /status, /vim-mode — already shipped and TUI-registered, but absent from a table that claims to list every slash command

cli/index.mdx — new "Checking your account, plan, and billing" section covering /status, /upgrade, and /manage-billing. /manage-billing is documented as admin-only because the CLI only registers it when manage_billing_url resolves for the signed-in user (app/src/terminal/input/slash_commands/data_source/tui.rs).

cli/models-and-usage.mdx and agents/inference/grok-subscription.mdx — /connect-grok documented as the CLI shortcut into the same xAI sign-in that /api-keys exposes.

cli/input-and-shell-commands.mdx — short "Vim mode" subsection for /vim-mode, which was previously only referenced indirectly through the statusline indicator.

cli/configuration.mdx — /reset-statusline noted alongside /statusline.

Verification

  • All three flagged slash commands are ungated (Availability::ALWAYS / AI_ENABLED, no feature flag) and SlashCommandSurfaces::TuiOnly, so they are GA and CLI-only.
  • Behavior confirmed against crates/warp_tui/src/terminal_session_view.rs (execute_tui_slash_command) and terminal_session_view/status_menu.rs.
  • npm run build passes (364 pages).
  • Internal link check passes (3457 links, 0 broken).
  • Re-running the audit drops undocumented_slash_commands from 3 to 0.

Deferred findings from this audit run

Nothing else in this run needs a doc page, but these were triaged and deliberately left for other owners:

  • 3 public API endpoints missing from developers/agent-api-openapi.yaml (GET /agent/artifacts/{artifactUid}/download, GET /agent/run-by-external-reference, POST /agent/runs/{runId}/scores). They are present and non-x-internal in warp-server's canonical spec, so they belong in the published subset — but the regeneration is a wholesale rewrite that would also publish research-preview Agent Memory schemas (AgentMemoryCreateConfig, AgentAutoMemoryResponse, MemoryStoreAttachmentResponse, …) that are transitively referenced from CreateAgentRequest/AgentResponse. Per the skill's public/private guardrail this is deferred to a dedicated sync-openapi-spec run once that exposure is settled. Details are in the companion bookkeeping PR.
  • 30 low-severity terminology findings, owned by style_lint. Details in the companion bookkeeping PR.

Surface map and snapshot updates for this run ship in the companion audit-bookkeeping PR.

Rework changes

Addressed all findings from the adversarial review pass (rework cycle 1):

  • /orchestrate missing from the slash command table (IMPORTANT) — Added a row for /orchestrate to cli/reference.mdx. Verified against the TUI registry (app/src/search/slash_command_menu/static_commands/commands.rs): it is unconditionally registered (commands.push(ORCHESTRATE.clone()), no feature-flag gate) with SlashCommandSurfaces::GuiAndTui and Availability::LOCAL | Availability::AI_ENABLED, and takes an optional [task] argument. The new row links to the existing multi-agent orchestration doc.
  • /version incorrectly documented as a slash command (IMPORTANT) — Removed the /version row from the slash command table and reworded the Troubleshooting > Updating paragraph so it only points to the warp --version command-line flag. Confirmed via the TUI registry's own test, version_command_is_not_registered (app/src/search/slash_command_menu/static_commands/commands_tests.rs), which asserts no /version command exists in either GUI or TUI mode.
  • No visual proof for a user-facing docs change (IMPORTANT) — Rendered the updated page locally (npm run preview) and captured screenshots of the full slash-commands table via computer use, confirming /orchestrate is present with the [task] argument and /version is absent, and that the Updating section no longer mentions /version. Screenshots are attached below.

Validation for this rework cycle: npm run build (364 pages, no errors), npm run typecheck (astro check: 0 errors), and the internal link checker (3458 links, 0 broken) all pass. trunk (the repo's configured lint/fmt tool) is not installed in this sandbox, consistent with the review run.

Computer-use screenshots (2)

Top of the Slash commands table on /cli/reference/, showing rows from /agent through /export-to-file.
Top of the Slash commands table on /cli/reference/, showing rows from /agent through /export-to-file.

Bottom of the Slash commands table showing /handoff through /voice, including the /orchestrate row with [task] argument.
Bottom of the Slash commands table showing /handoff through /voice, including the /orchestrate row with [task] argument.

Conversation: https://staging.warp.dev/conversation/52a9f9f7-2e0a-43ae-82c4-84a04c9d4eb1
Run: https://oz.staging.warp.dev/runs/019fdd2a-edce-719d-9dc1-678ca78ec7e0
Rework conversation: https://staging.warp.dev/conversation/0ce3f923-c90c-4034-ad80-f3b75b922650
Rework run: https://oz.staging.warp.dev/runs/019fe7e8-f2c9-79f6-b917-20360e5a448f

This PR was generated with Oz.

@hongyi-chen @warp-agent
docs(cli): document the new Warp Agent CLI slash commands
037c314 
Adds /connect-grok, /manage-billing, and /upgrade, which the docs audit
flagged as new but undocumented slash commands, and fills the remaining
gaps in the CLI slash command table (/fork, /reset-statusline, /status,
/vim-mode) so it matches the registry in static_commands/commands.rs.

Co-Authored-By: Warp Agent <agent@warp.dev>
@hongyi-chen hongyi-chen added the documentation Improvements or additions to documentation label Aug 7, 2026
@cla-bot cla-bot Bot added the cla-signed label Aug 7, 2026
@vercel

vercel Bot commented Aug 7, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 9, 2026 7:14pm

Request Review

@hongyi-chen
hongyi-chen requested a review from moirahuang August 7, 2026 17:15
@hongyi-chen
hongyi-chen marked this pull request as ready for review August 9, 2026 18:38
@oz-for-oss

oz-for-oss Bot commented Aug 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

oz-for-oss[bot]
oz-for-oss Bot reviewed Aug 9, 2026
View reviewed changes

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR documents newly available Warp Agent CLI slash commands across the CLI overview, reference, configuration, model usage, input, and Grok subscription pages. The changed content aligns with the attached diff context, keeps the slash command reference consistent with the TUI command surface, and does not introduce code, configuration, or security-sensitive behavior.

Concerns

  • No blocking concerns found.
  • No approved or repository spec context was provided, so there is no implementation-spec drift to report.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@warp-agent-staging warp-agent-staging Bot added the warpy-factory Opened by the Warp factory agents label Aug 9, 2026
@oz-agent @warp-agent
docs(cli): add /orchestrate and remove unregistered /version slash co…
6a7be2f 
…mmand

- Add the /orchestrate slash command to the reference table: it is
  always registered for local, AI-enabled sessions on both GUI and
  TUI surfaces (see warpdotdev/warp
  app/src/search/slash_command_menu/static_commands/commands.rs).
- Remove /version from the slash command table: the TUI registry
  test version_command_is_not_registered asserts no such command
  exists. warp --version remains documented under command-line
  flags, and the Troubleshooting > Updating section no longer
  references a /version slash command.

Co-Authored-By: Warp Agent <agent@warp.dev>
@hongyi-chen
hongyi-chen enabled auto-merge (squash) August 9, 2026 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oz-for-oss oz-for-oss[bot] oz-for-oss[bot] left review comments
@moirahuang moirahuang Awaiting requested review from moirahuang

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

cla-signed documentation Improvements or additions to documentation warpy-factory Opened by the Warp factory agents

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hongyi-chen @oz-agent